PATHMac OS 8 Developer Documentation > Networking and Communications > AppleShare >

User Authentication Modules

UAMMessage Structure

The UAMMessage structure is used by the client UAM to pass information back to the AFP client when the client UAM calls the AFP client's OpenRequest and SendRequest callback routines. A UAMMessage structure is also passed as a parameter to the client UAM's completion routine.



 
struct UAMMessage {

    short           commandCode;

    short           sessionRefNum;

    unsigned char   *cmdBuffer;

    unsigned long   cmdBufferSize;

    unsigned char   *replyBuffer;

    unsigned long   replyBufferSize;

    CompletionPtr   *completion;

    void *contextPtr;

};

typedef struct UAMMessage UAMMessage, *UAMMessagePtr;

commandCode: A command code. The value of commandCode must be one of the following:; enum {; kOpenSession = 'UAOS '; kSendRequest = 'UASR '; };
sessionRefNum: The session reference number for this session, returned when the value of commandCode is kOpenSession and passed back in subsequent messages sent via the OpenSession callback.
cmdBuffer: A pointer to a buffer containing an AFP command, such as afpLogin or afpContLogin , and the command parameters for that command. For a complete list of AFP commands, see Inside Macintosh: Networking.
cmdBufferSize: The length of the command in cmdBuffer .
replyBuffer: A pointer to a buffer that is used to return a reply.
replyBufferSize: The length of the reply in replyBuffer .
completion: A pointer to a completion routine.
contextPtr: A pointer to a value that identifies this session. If contextPtr is not nil, it is passed to a completion routine when completion routine is called.